/*
 * File     : Freeable.java
 * Created  : 22 Apr 2011
 *
 * Copyright © 2011 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni.type;

/**
 * <p>
 *  Base interface for any object that has an explicitly managed lifetime.
 * </p>
 * <h3>Notice</h3>
 * <p>
 *  <strong>
 *   This type is not intended for general extension by users of DNI.
 *  </strong>
 * </p>
 *
 * @author Matthew Wilson
 */
public interface Freeable
{

    /**
     * <p>
     *  Frees the native memory used by this object.
     * </p>
     * <p>
     *  The behaviour of other methods, including this method, after freeing is
     *  completely undefined; undefined behaviour includes, but is not limited
     *  to system crashes and exceptions.
     * </p>
     */
    void free();

}
